home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / networking / amitcp / clchat33.lha / CLChat33 / Client / CLChatGUI.doc < prev    next >
Encoding:
Text File  |  1995-03-10  |  7.3 KB  |  217 lines
  1.  
  2.  
  3. CLChatGUI
  4. *********
  5.  
  6. Welcome to the CLChatGUI, a full-featured GUI client to the
  7. CLChatSystem for AmiTCP.  The CLChatSystem, which is
  8. originally part of the Connectline BBS package, provides a
  9. single-server, IRC-like chat system with multiple channels, private
  10. messaging, operator privileges and more.
  11.  
  12. Within Connectline, also online user and Hydra file transfer
  13. protocol chat user may join the chat.  See the `CLChatServer
  14. Documentation' for more information about Connectline.
  15.  
  16. Connecting
  17. **********
  18.  
  19. Before you can use CLChatGUI, you must connect to a chat server
  20. running CLChatD.
  21.  
  22. When started, CLChatGUI will prompt you for a server name and a port
  23. number to connect to.
  24.  
  25. If you are connected to a LAN, you should ask your network adminstrator
  26. for both server name and port number.
  27.  
  28. If you are connected to the Internet, you may try
  29. pluribus.wupper.de at port 5555, but be warned that the Internet
  30. link of this machine is temporary and generally down.
  31.  
  32. You must also specify a Nickname and your Realname.  The nickname
  33. is a kind of username used within the chat system.  It may be up to 16
  34. byte long and must consist of letters, digits and the characters .
  35. and _. The realname is used for informational purposes only.
  36.  
  37. Note that the server may reject your connection attempt because the
  38. entered nickname is invalid or already in use by another chat user.
  39. Change your nick and retry the connection.
  40.  
  41. Local chat
  42. **********
  43.  
  44. If you start the client on a machine running the CLChatServer, it
  45. will not connect using AmiTCP, but directly link to the chat server to
  46. reduce overhead.
  47.  
  48. If you want to avoid this behaviour, e.g. for testing purposes, start
  49. CLChatGUI with the TCPMode keyword.
  50.  
  51. Using CLChatGUI
  52. ***************
  53.  
  54. After connecting to the chat server, the main window opens.  It
  55. consists of a channel selection gadget, a topic gadget, the main output
  56. window, your input string gadget and the user operation gadget group.
  57. It also features a menu bar with several options and shortcuts for
  58. server commands.
  59.  
  60. You send text to the chat server by simply entering it in the input
  61. gadget.  Commands are also send to the server by entering them in the
  62. input gadget.  You may want to use the /HELP command to learn about
  63. available server commands.  The input gadget is normally automatically
  64. activated; if it is not, simply press SPACE to activate it.  A
  65. history of the last 100 lines entered is kept; you may use
  66. Cursor/UP or Cursor/DOWN for accessing entries in the history.
  67.  
  68. Changing channels is done by entering a new channel name in the channel
  69. selection gadget.  Note that the server will automatically create a
  70. channel if it does not exist. Already existing channels may be selected
  71. with the popup listview right of the channel gadget. The popup button
  72. has a hidden keyboard shortcut h which opens the channel selection
  73. listview.
  74.  
  75. If you have channel operator status, you may change the current
  76. channel's topic by entering a new one in the topic gadget.  The
  77. contents of this gadget are automatically updated if someone else
  78. changes the topic.
  79.  
  80. User operations
  81. ***************
  82.  
  83. The user listview displays all users currently logged into the chat
  84. server and the name of the channel they are currently on. Users with
  85. channel operator privilege are marked with a @, users with chat
  86. operator privilege are marked with a ! before the name.
  87.  
  88. Double clicking on an entry in the user listview requests a /WHOIS
  89. user command from the server.  Pressing the Dialog button opens a
  90. special so-called dialog window.  A dialog window works much like the
  91. main windows, but every text entered within a dialog window is send
  92. directly as a private message to the user.  Also, any incoming private
  93. messages from this user are displayed in the dialog window and not the
  94. main window.  If the Auto checkbox is selected, a new dialog window
  95. is created for the originator of every incoming private message.
  96.  
  97. If you have channel or chat operator privilege, you may also use the
  98. OP, DEOP and KICK buttons to perform the requested operation on
  99. the selected user.
  100.  
  101. Setup
  102. *****
  103.  
  104. In the setup window, you may modify several operation attributes.
  105.  
  106.     Autoconnect will cause an automatic connection attempt each time
  107. the CLChatGUI is started.
  108.  
  109.     Max. Number of Lines specifies how many lines of incoming text
  110. will be stored for the output listview.
  111.  
  112. The Event Handling checkboxes set the reaction of special events.
  113. You may set Deiconify to automatically deiconify the application on
  114. the given event, and DisplayBeep to just have the screen beep.
  115.  
  116. You may create several different configuration files using the
  117. Save... and Load... items from the menu bar.  If you create
  118. icons for the configurations, you can start CLChatGUI by simply
  119. doubly clicking on the configuration icon.
  120.  
  121. ARexx commands
  122. **************
  123.  
  124.     CLChatGUI features an ARexx port. The port name is
  125. CLCHATCLIENT.nr, with nr starting at 1 and increasing for
  126. every instance of the program started.
  127.  
  128. Besides the builtin MUI commands (see the `MUI User Guide'),
  129. CLChatGUI current features two commands:
  130.  
  131. SEND TEXT/F
  132.      Sends the given text string as it was entered in the input string
  133.      gadget.  Note that you may also send server commands this way.
  134.  
  135. RECONNECT
  136.      Cause the CLChatGUI to reconnect to the current server.
  137.  
  138. Server Commands
  139. ***************
  140.  
  141. Below is a list of normally available server commands. Don't forget to
  142. use the /HELP command to learn if your server supports a different
  143. command set.
  144.  
  145.    * /CHANNEL [name]
  146.      join or create a channel
  147.  
  148.    * /INFO [name]
  149.      show all or specific channel
  150.  
  151.    * /WHO
  152.      list users in channel
  153.  
  154.    * /USERS
  155.      list all users in chat
  156.  
  157.    * /WHOIS nick
  158.      show info about user
  159.  
  160.    * /MSG nick msg
  161.      send private msg to nick
  162.  
  163.    * /NICK [nick]
  164.      view or change your nick
  165.  
  166.    * /ME msg
  167.      send action string
  168.  
  169.    * /VERSION
  170.      show server version
  171.  
  172.     Operator only commands:
  173.  
  174.    * /OP nick
  175.      give operator state to nick
  176.  
  177.    * /DEOP nick
  178.      remove operator state from nick
  179.  
  180.    * /TOPIC topic
  181.      set topic of channel
  182.  
  183.    * /KICK nick reason
  184.      kick nick out of channel
  185.  
  186. Copyright
  187. *********
  188.  
  189. The CLChatSystem (CLChatServer, CLChatD and CLChatGUI) is (C)
  190. 1994-1995 Oliver Wagner, All Rights Reserved.
  191.  
  192. The package may be distributed freely as long as all files are
  193. distributed as a whole archive and are not modified in any way.
  194.  
  195.     CLChatGUI is a MUI application.  MUI is (C) 1993-95 Stefan
  196. Stuntz.
  197.  
  198.     AmiTCP is (C) 1994-1995 NSDI Inc.
  199.  
  200. Please send bug-reports, suggestions and comments to
  201. o.wagner@pluribus.wupper.de.
  202.  
  203. Index
  204. *****
  205.  
  206.  
  207.  
  208.  ARexx commands                         ARexx commands
  209.  Connecting                             Connecting
  210.  Copyright                              Copyright
  211.  Local chat                             Connecting
  212.  Server Commands                        Server Commands
  213.  Setup                                  Setup
  214.  User operations                        Using CLChatGUI
  215.  Using CLChatGUI                        Using CLChatGUI
  216.  
  217.